home *** CD-ROM | disk | FTP | other *** search
/ Workbench Add-On / Workbench Add-On - Volume 1.iso / Dev / SmallTalk / PositionableStream.st < prev    next >
Text File  |  1995-08-25  |  5KB  |  204 lines
  1. "======================================================================
  2. |
  3. |   PositionableStream Method Definitions
  4. |
  5.  ======================================================================"
  6.  
  7.  
  8. "======================================================================
  9. |
  10. | Copyright (C) 1990, 1991, 1992 Free Software Foundation, Inc.
  11. | Written by Steve Byrne.
  12. |
  13. | This file is part of GNU Smalltalk.
  14. |
  15. | GNU Smalltalk is free software; you can redistribute it and/or modify it
  16. | under the terms of the GNU General Public License as published by the Free
  17. | Software Foundation; either version 1, or (at your option) any later version.
  18. | 
  19. | GNU Smalltalk is distributed in the hope that it will be useful, but WITHOUT
  20. | ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  21. | FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  22. | details.
  23. | 
  24. | You should have received a copy of the GNU General Public License along with
  25. | GNU Smalltalk; see the file COPYING.  If not, write to the Free Software
  26. | Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.  
  27. |
  28.  ======================================================================"
  29.  
  30.  
  31. "
  32. |     Change Log
  33. | ============================================================================
  34. | Author       Date       Change 
  35. | sbb         16 Mar 91      Class creation now separate statement.
  36. |
  37. | sbyrne     19 Sep 89      Converted to use real method categories
  38. |
  39. | sbyrne     25 Apr 89      created.
  40. |
  41. "
  42.  
  43. Stream subclass: #PositionableStream
  44.        instanceVariableNames: 'collection ptr endPtr access'
  45.        classVariableNames: ''
  46.        poolDictionaries: ''
  47.        category: nil
  48. !
  49.  
  50. PositionableStream comment: 
  51. 'My instances represent streams where explicit positioning is permitted.
  52. Thus, my streams act in a manner to normal disk files: you can read
  53. or write sequentially, but also position the file to a particular place
  54. whenever you choose.  Generally, you''ll want to use ReadStream, WriteStream
  55. or ReadWriteStream instead of me to create and use streams.' !
  56.  
  57.  
  58. !PositionableStream class methodsFor: 'instance creation'!
  59.  
  60. on: aCollection
  61.     self subclassResponsiblity
  62. !
  63.  
  64. on: aCollection from: firstIndex to: lastIndex
  65.     ^self on: (aCollection copyFrom: firstIndex to: lastIndex)
  66.  
  67. !!
  68.  
  69.  
  70.  
  71. !PositionableStream methodsFor: 'accessing-reading'!
  72.  
  73. next
  74.     | element |
  75.     (access bitAnd: 1) = 0
  76.         ifTrue: [ ^self shouldNotImplement ].
  77.     self atEnd ifTrue: [ ^self error: 'end of stream reached' ].
  78.     element _ collection at: ptr.
  79.     ptr _ ptr + 1.
  80.     ^element
  81. !
  82.  
  83. next: anInteger
  84.     "Returns a collection of the same type that the stream accesses, that has
  85.     the next anInteger elements from the stream."
  86.     | newStream |
  87.     newStream _ WriteStream on: (collection species new: 0).
  88.     anInteger timesRepeat: [ newStream nextPut: (self next) ].
  89.     ^newStream contents
  90. !
  91.  
  92. peek
  93.     "Returns the next element of the stream without moving the pointer.
  94.     Returns nil when at end of stream."
  95.     | peekValue |
  96.     self atEnd ifTrue: [ ^nil ].
  97.     peekValue _ self next.
  98.     self skip: -1.
  99.     ^peekValue    
  100. !
  101.  
  102. peekFor: anObject
  103.     "Returns true and gobbles the next element from the stream of it is
  104.     equal to anObject, returns false and doesn't gobble the next element
  105.     if the next element is not equal to anObject."
  106.     (self peek) = anObject
  107.         ifTrue: [ self next.
  108.               ^true ]
  109.         ifFalse: [ ^false ]
  110. !
  111.  
  112. upTo: anObject
  113.     "Returns a collection of the same type that the stream accesses, up to 
  114.     but not including the object anObject.  Returns the entire rest of the 
  115.     stream's contents if anObject is not present.  ### Should this use = or
  116.     ==."
  117.     | newStream |
  118.     newStream _ WriteStream on: (collection species new: 0).
  119.     [ self atEnd or: [ self peek ~= anObject ] ] whileFalse:
  120.         [ newStream nextPut: (self next) ].
  121.     ^newStream contents
  122. !
  123.  
  124. contents
  125.     "Returns a collection of the same type that the stream accesses, up to 
  126.     and including the final element."
  127.     ^collection copyFrom: 1 to: endPtr
  128. !
  129.  
  130. reverseContents
  131.     "Returns a collection of the same type that the stream accesses, up to 
  132.     and including the final element, but in reverse order."
  133.     | newCollection |
  134.     newCollection _ collection species new: endPtr.
  135.     1 to: endPtr do:
  136.         [ :i | newCollection at: i put: (collection at: endPtr - i + 1) ].
  137.     ^newCollection
  138. !!
  139.  
  140.  
  141.  
  142. !PositionableStream methodsFor: 'testing'!
  143.  
  144. atEnd
  145.     ^ptr > endPtr
  146. !
  147.  
  148. isEmpty
  149.     ^endPtr = 0
  150. !!
  151.  
  152.  
  153.  
  154. !PositionableStream methodsFor: 'enumerating'!
  155.  
  156. !
  157.  
  158.  
  159.  
  160. !PositionableStream methodsFor: 'positioning'!
  161.  
  162. position
  163.     ^ptr
  164. !
  165.  
  166. position: anInteger
  167.     (anInteger between: 1 and: endPtr)
  168.     ifTrue: [ ptr _ anInteger ]
  169.     ifFalse: [ ^self error: 'position out of range' ]
  170. !
  171.  
  172. reset
  173.     ptr _ 1
  174. !
  175.  
  176. setToEnd
  177.     ptr _ endPtr + 1
  178. !
  179.  
  180. skip: anInteger
  181.     ptr _ (ptr + anInteger max: 1) min: endPtr
  182. !
  183.  
  184. skipTo: anObject
  185.     "Moves the current position to after the next occurrence of anObject
  186.     and returns true if anObject was found.  If anObject doesn't exist, the 
  187.     position is unchanged, and false is returned."
  188.     | curPos |
  189.     curPos _ self position.
  190.     [ self atEnd ] whileFalse:
  191.         [ (self nextMatchFor: anObject)
  192.         ifTrue: [ ^true ] ].
  193.     self position: curPos.
  194.     ^false    
  195.  
  196. !!
  197.  
  198.  
  199. !PositionableStream methodsFor: 'private'!
  200.  
  201. access: anInteger
  202.     access _ anInteger
  203. !!
  204.